Merciful 5/Merciful - Disc 5.iso/software/h/hypertextdatav40.12cr.lha/HTDS/Docs/hyperguide.hguide

Amiga HyperGuide | 1997-03-30 | 35.0 KB | 1,051 lines

@hyperguide HyperGuide.hguide
@$VER: HyperGuide.hguide 40.14 (30.03.97)
@macro m_prg "@{b}HyperGuide DataType@{ub}"
@macro m_hg_example "The following HyperGuide code :@{line}@{code}@{fg highlight}"
@macro m_hg_exampleend "@{body}@{line}@{fg text}produces : @{line}"
@macro m_cmdsect "@{line}Section : @{b}$1@{ub}"
@macro m_hgnew   "@{line}@{m_bold \"New for $1 hyperguide.datatype.\"}"
@macro m_attr "@{label $1}\\\@{$1 $2}"
@macro m_cmd "@{label $1}\\\@$1 $2"
@include htds.hgm

@node main "HyperGuide DataType Documentation"
@toc HTDS.hguide/main
@prev hypertext.hguide/main
@next html.hguide/main

@{jcenter}@{m_title}@{m_copyright}@{m_welcome}@{jleft}

@{settabs 30}
@{m_sec Menu}
@{m_menuitem}@{" Configuration " link Configuration            }@{m_menuinfo "Adapt to your needs"}
@{m_menuitem}@{" Commands "      link Cmds                     }@{m_menuinfo "Overview"}
@{m_menuitem}@{" Attributes "    link Attrs                    }@{m_menuinfo "Overview"}
@{m_menuitem}@{" Standard macros " link StdMacros              }@{m_menuinfo "let the user decide"}
@{m_menuitem}@{" Compatibility " link Compatibility            }@{m_menuinfo "with AmigaGuide"}
@{m_menuitem}@{" New Features "  link NewFeatures              }@{m_menuinfo "compared to AmigaGuide"}
@{line}
@{m_menuitem}@{" Copyright "     link HTDS.hguide/Copyright    }@{m_menuinfo "legal stuff"}
@{m_menuitem}@{" Author "        link SR.hguide/Addresses      }@{m_menuinfo "how to contact me"}
@{m_menuitem}@{" Registration "  link HTDS.hguide/Registration }@{m_menuinfo "It's Shareware !!!"}
@{m_endsec}

@endnode
@node Configuration "HyperGuide/Configuration"

@{m_sec "Configuration"}
As the recommended standard for datatypes, the preference file for the
hyperguide.datatype is called @{m_file hyperguide.prefs} and is searched first in the
@{m_file PROGDIR:Prefs/DataTypes} and then in the @{m_file Env:DataTypes} directory.
The following options are currently available using ReadArgs() argument parsing :

@{definition}
MACRODIR/K,DEBUG/S :

@{defterm}MACRODIR
@{defdata}Specifies the directory, which contains all macro files/packages.
Also macro files are search in the directory of the @{hyperguide} file it
referenced it.

@{defterm}DEBUG
@{defdata}If this option is turned on, all unknown attributes and commands are
reported to the serial line using the KPrintF() function.
@{enddefinition}
@{m_endsec}
@endnode

@node Cmds "HyperGuide/Commands"

@{m_sec "Information"}
Here some general information about @{hyperguide} commands.
@{itemize}
@{item}Each command must start at the beginning of a line.
@{item}Commands can be used in the global section (outside of a node) and
within a node. For the possible usage of each command see the @{m_bold Section}
line in the documentation of the command.
@{enditemize}
@{m_endsec}
@{m_sec "Commands"}
@{m_high "Theme index"}@{line}
@{settabs 20 40 60 80 100}
@{" Background " link Cmds_Background}@{tab}
@{" Information " link Cmds_Info}@{tab}
@{" Macro " link Cmds_Macro}@{tab}
@{" Misc " link Cmds_Misc}@{tab}
@{" Navigation " link Cmds_Nav}@{tab}
@{" Node " link Cmds_Node}@{tab}
@{" Preference " link Cmds_Prefs}@{tab}
@{line}@{line}
@{m_high "Alphabetic index"}@{line}
@{" @$VER: ... " link Cmds_Info#VER}@{tab}
@{" @(c) ... " link Cmds_Info#(c)}@{tab}
@{" @altfgcolor ... " link Cmds_Background#altfgcolor}@{tab}
@{" @altfgpen ... " link Cmds_Background#altfgpen}@{tab}
@{" @annotation ... " link Cmds_Info#annotation}@{tab}
@{" @author ... " link Cmds_Info#author}@{tab}
@{" @background ... " link Cmds_Background#background}@{tab}
@{" @bgcolor ... " link Cmds_Background#bgcolor}@{tab}
@{" @bgpen ... " link Cmds_Background#bgpen}@{tab}
@{" @depth ... " link Cmds_Prefs#depth}@{tab}
@{" @endnode " link Cmds_Node#endnode}@{tab}
@{" @fgcolor ... " link Cmds_Background#fgcolor}@{tab}
@{" @fgpen ... " link Cmds_Background#fgpen}@{tab}
@{" @font ... " link Cmds_Prefs#font}@{tab}
@{" @help ... " link Cmds_Nav#help}@{tab}
@{" @hyperguide ... " link Cmds_Node#hyperguide}@{tab}
@{" @include ... " link Cmds_Macro#include}@{tab}
@{" @index ... " link Cmds_Nav#index}@{tab}
@{" @listindent ... " link Cmds_Prefs#listindent}@{tab}
@{" @macro ... " link Cmds_Macro#macro}@{tab}
@{" @master ... " link Cmds_Info#master}@{tab}
@{" @next ... " link Cmds_Nav#next}@{tab}
@{" @node ... " link Cmds_Node#node}@{tab}
@{" @prev ... " link Cmds_Nav#prev}@{tab}
@{" @rem ... " link Cmds_Misc#rem}@{tab}
@{" @remark ... " link Cmds_Misc#remark}@{tab}
@{" @smartwrap " link Cmds_Prefs#smartwrap}@{tab}
@{" @tab ... " link Cmds_Prefs#tab}@{tab}
@{" @title ... " link Cmds_Node#title}@{tab}
@{" @toc ... " link Cmds_Nav#toc}@{tab}
@{" @wordwrap " link Cmds_Prefs#wordwrap}@{tab}
@{m_endsec}
@endnode
@node Cmds_Info "HyperGuide/Commands/Information"

@{m_sec "Information"}
@{definition}
@{defterm}@{label VER}\@$VER: "<version string>"
@{defdata}Specify the version of the database. This command must always be upper-case,
so that the @{m_file version} program can also find the version information.
@{m_cmdsect "global"}

@{defterm}@{m_cmd "(c)" "<string>"}
@{defterm}@{m_cmd copyright "<string>"}
@{defdata}Specify the copyright notice for the database.
@{m_cmdsect "global"}

@{defterm}@{m_cmd annotation "<string>"}
@{defdata}Specify a annotation for the database.
@{m_cmdsect "global"}

@{defterm}@{m_cmd author "<string>"}
@{defdata}Specify the author of the database.
@{m_cmdsect "global"}
@{m_endsec}

@{m_sec "See Also"}
@{" About Requester " link hypertext.hguide/UserIFace_AboutRequester}
@{m_endsec}
@endnode
@node Cmds_Macro "HyperGuide/Commands/Macro"

@{m_sec "Macro"}
@{definition}
@{defterm}@{m_cmd macro name "string"}
@{defdata}assigns to a macro named @{m_sample name} the @{m_sample string} string.
A macro can be used the same way as an attribute command, and can consist of
other attribute commands, macros or texts. An argument can be accessed within
the macro string using the @{m_sample $} character followed by the argument
number. If you want to use the @{m_sample "\""} character, you have to escape it
with the @{m_sample "\\"} character. For example :
@{m_sample "\@macro m_item \"\\\@{object \\\"My PicDisk:mybullet.png\\\"}"}@{line}
The macro list is searched after the standard attribute command list (@{m_bold Note}:
This is the reverse order as of the amigaguide.datatype).
@{m_cmdsect "global"}

@{defterm}@{m_cmd include macrofile}
@{defdata}tries to load the @{m_sample macrofile} file. This file is first searched
in the directory of the document and if this fails in the directory configured in
the @{"prefs" link Configuration} file.
@{m_cmdsect "global"}
@{m_hgnew "V40"}
@{enddefinition}
@{m_endsec}

@{m_sec Recommendation}
To avoid conflicts with future attribute commands, please use a prefix for your macros
like @{m_sample m_} :@{line}@{line}
@{m_sample "\@macro m_bold \"\@{b}$1\@{ub}\""}
@{m_endsec}

@{m_sec Attention}
The current macro expansion is implemented using recursion. Because the function
is executed in DoAsnycLayout() context with a stacksize of 4096 it may crash the
system with deep macro recursions. Currently a depth of 3 was tested and its save.
@{m_endsec}

@{m_sec "See Also"}
@{" Default Macro File " link StdMacros}, @{" Defined List macros " link ATTRS_LISTS}
@{m_endsec}
@endnode
@node Cmds_Misc "HyperGuide/Commands/Misc"

@{m_sec "Misc"}
@{definition}
@{defterm}@{m_cmd rem string}
@{defterm}@{m_cmd remark string}
@{defdata}This is used to place remarks in the database. These remarks are
not displayed to the user.
@{m_cmdsect "node, global"}
@{m_endsec}
@endnode
@node Cmds_Nav "HyperGuide/Commands/Navigation"

@{m_sec "Navigation"}
@{definition}
@{defterm}@{m_cmd help <node>}
@{defdata}Specify the name of the help node, which will be accessed by the Help button.
@{m_cmdsect "node, global"}

@{defterm}@{m_cmd index <node>}
@{defdata}Specify the name of the index node, which will be accessed by the Index button
@{m_cmdsect "node, global"}

@{defterm}@{m_cmd next <node>}
@{defdata}Node to display when the user selects the "Browse >" button.
@{m_cmdsect "node"}

@{defterm}@{m_cmd prev <node>}
@{defdata}Node to display when the user selects the "Browse <" button.
@{m_cmdsect "node"}

@{defterm}@{m_cmd toc <node>}
@{defdata}Name of the node that contains the table of contents for this node. Defaults
to @{m_sample main}. This is the node that is displayed when the user selects
the "Contents" button.
@{m_cmdsect "node, global"}
@{enddefinition}
@{m_endsec}

@{m_sec "Note"}
Any node you can specifiy, can be a node or file in your system, which can be
displayed through the datatypes system.
@{m_endsec}
@endnode
@node Cmds_Node "HyperGuide/Commands/Node"

@{m_sec "Node"}
@{definition}
@{defterm}@{m_cmd endnode}
@{defdata}Indicate the end of a node.
@{m_cmdsect "node"}

@{defterm}@{m_cmd node "<node> <title>"}
@{defdata}Indicate the start of a node named @{m_sample "<node>"}. The first node in the
database must be named @{m_high main}. @{m_high Main} must be the master table
of contents for the database.
@{m_cmdsect "global"}

@{defterm}@{m_cmd title <title>}
@{defdata}Title to display in the title bar of the window during the display of this
node.
@{m_cmdsect "node"}
@{m_endsec}
@endnode
@node Cmds_Prefs "HyperGuide/Commands/Preference"

@{m_sec "Preference"}
@{definition}
@{defterm}@{m_cmd font "<name> <size>"}
@{defdata}Specify the font to use for the database or node.
@{m_cmdsect "node, global"}

@{defterm}@{m_cmd smartwrap}
@{defdata}This is used to indicate that the text of the database or node is to be
wordwrapped. It wordwraps a paragraph and not one physical line. To break
this use the following attributes or two physical line feeds (same as \@{par}) :
@{" @{line} " link ATTRS_PARAGRAPH}, @{" @{par} " link ATTRS_PARAGRAPH}
@{m_cmdsect "node, global"}

@{defterm}@{m_cmd tab <size>}
@{defdata}Number of spaces in a tab. Defaults to 8.
@{m_cmdsect "node, global"}

@{defterm}@{m_cmd wordwrap}
@{defdata}Turns on wordwrapping.
@{m_cmdsect "node, global"}

@{defterm}@{m_cmd depth <num>}
@{defdata}Specifies the number of bitplanes, which should be used for this
@{hyperguide} document.
@{m_cmdsect "global"}

@{defterm}@{m_cmd listindent <num>}
@{defdata}Specifies the number of spaces to indent for each list.
See @{" list attributes " link ATTRS_LISTS}.
@{m_cmdsect "node, global"}
@{enddefinition}
@{m_endsec}

@endnode
@node Cmds_Background "HyperGuide/Commands/Background"

@{m_sec "Background"}
@{definition}
@{defterm}@{m_cmd background "<picture>"}
@{defdata}Specify the background picture for the database or node.
@{m_cmdsect "node, global"}

@{defterm}@{m_cmd bgpen "<pen>"}
@{defdata}Specify the pen to use as background color for the database or node.
@{m_cmdsect "node, global"}

@{defterm}@{m_cmd fgpen "<pen>"}
@{defdata}Specify the pen to use as foreground color for the database or node.
@{m_cmdsect "node, global"}

@{defterm}@{m_cmd altfgpen "<pen>"}
@{defdata}Specify the pen to use as an alternate foreground color for the database or node.
This pen is used, if the foreground and background color are equal.
@{m_cmdsect "node, global"}

@{defterm}@{m_cmd bgcolor "<color expression>"}
@{defdata}Same as @{m_sample \@bgpen} except you can use a @{"color expression" link hypertext.hguide/ColorExpressions}.
@{m_cmdsect "node, global"}

@{defterm}@{m_cmd fgcolor "<color expression>"}
@{defdata}Same as @{m_sample \@fgpen} except you can use a @{"color expression" link hypertext.hguide/ColorExpressions}.
@{m_cmdsect "node, global"}

@{defterm}@{m_cmd altfgcolor "<color expression>"}
@{defdata}Same as @{m_sample \@altfgpen} except you can use a @{"color expression" link hypertext.hguide/ColorExpressions}.
@{m_cmdsect "node, global"}

@{enddefinition}
@{m_endsec}
@endnode

@node Attrs "HyperGuide/Attributes"

@{m_sec "Attributes"}
@{m_high "Theme index"}@{line}
@{settabs 22 44 66 88 110}
@{" Justification " link ATTRS_JUSTIFICATION}@{tab}
@{" Links " link ATTRS_LINKS}@{tab}
@{" Lists " link ATTRS_LISTS}@{tab}
@{" Misc " link ATTRS_MISC}@{tab}
@{" Paragraph " link ATTRS_PARAGRAPH}@{tab}
@{" Tabulator " link ATTRS_TABULATOR}@{tab}
@{" Text Color " link ATTRS_TEXTCOLOR}@{tab}
@{" Text Font " link ATTRS_TEXTFONT}@{tab}
@{" Text Style " link ATTRS_TEXTSTYLE}@{tab}
@{line}@{line}
@{m_high "Alphabetic index"}@{line}
@{" @{<text> ...} " link ATTRS_LINKS#link}@{tab}
@{" @{amigaguide} " link ATTRS_MISC#amigaguide}@{tab}
@{" @{apen ...} " link ATTRS_TEXTCOLOR#apen}@{tab}
@{" @{bg ...} " link ATTRS_TEXTCOLOR#bg}@{tab}
@{" @{bgrgb ...} " link ATTRS_TEXTCOLOR#bgrgb}@{tab}
@{" @{body} " link ATTRS_PARAGRAPH#body}@{tab}
@{" @{bpen ...} " link ATTRS_TEXTCOLOR#bpen}@{tab}
@{" @{b} " link ATTRS_TEXTSTYLE#b}@{tab}
@{" @{cleartabs} " link ATTRS_TABULATOR#cleartabs}@{tab}
@{" @{code} " link ATTRS_PARAGRAPH#code}@{tab}
@{" @{defdata} " link ATTRS_LISTS#defdata}@{tab}
@{" @{deffont} " link ATTRS_TEXTFONT#deffont}@{tab}
@{" @{definition} " link ATTRS_LISTS#definition}@{tab}
@{" @{defterm} " link ATTRS_LISTS#defterm}@{tab}
@{" @{enddefinition} " link ATTRS_LISTS#enddefinition}@{tab}
@{" @{endenumerate} " link ATTRS_LISTS#endenumerate}@{tab}
@{" @{enditemize} " link ATTRS_LISTS#enditemize}@{tab}
@{" @{enumerate} " link ATTRS_LISTS#enumerate}@{tab}
@{" @{fg ...} " link ATTRS_TEXTCOLOR#fg}@{tab}
@{" @{fgrgb ...} " link ATTRS_TEXTCOLOR#fgrgb}@{tab}
@{" @{font ...} " link ATTRS_TEXTFONT#font}@{tab}
@{" @{hyperguide} " link ATTRS_MISC#hyperguide}@{tab}
@{" @{itemize ...} " link ATTRS_LISTS#itemize}@{tab}
@{" @{item} " link ATTRS_LISTS#item}@{tab}
@{" @{i} " link ATTRS_TEXTSTYLE#i}@{tab}
@{" @{jcenter} " link ATTRS_JUSTIFICATION#jcenter}@{tab}
@{" @{jleft} " link ATTRS_JUSTIFICATION#jleft}@{tab}
@{" @{jright} " link ATTRS_JUSTIFICATION#jright}@{tab}
@{" @{label ...} " link ATTRS_LINKS#label}@{tab}
@{" @{lindent ...} " link ATTRS_PARAGRAPH#lindent}@{tab}
@{" @{line} " link ATTRS_PARAGRAPH#line}@{tab}
@{" @{link ...} " link ATTRS_LINKS#link}@{tab}
@{" @{object ...} " link ATTRS_MISC#object}@{tab}
@{" @{pard} " link ATTRS_PARAGRAPH#pard}@{tab}
@{" @{pari ...} " link ATTRS_PARAGRAPH#pari}@{tab}
@{" @{par} " link ATTRS_PARAGRAPH#par}@{tab}
@{" @{plain} " link ATTRS_TEXTSTYLE#plain}@{tab}
@{" @{quit ...} " link ATTRS_LINKS#quit}@{tab}
@{" @{runcommand ...} " link ATTRS_LINKS#runcommand}@{tab}
@{" @{rx ...} " link ATTRS_LINKS#rx}@{tab}
@{" @{rxs ...} " link ATTRS_LINKS#rxs}@{tab}
@{" @{separator} " link ATTRS_MISC#separator}@{tab}
@{" @{settabs ...} " link ATTRS_TABULATOR#settabs}@{tab}
@{" @{style ...} " link ATTRS_TEXTSTYLE#style}@{tab}
@{" @{system ...} " link ATTRS_LINKS#system}@{tab}
@{" @{tab} " link ATTRS_TABULATOR#tab}@{tab}
@{" @{ub} " link ATTRS_TEXTSTYLE#ub}@{tab}
@{" @{ui} " link ATTRS_TEXTSTYLE#ui}@{tab}
@{" @{uu} " link ATTRS_TEXTSTYLE#uu}@{tab}
@{" @{u} " link ATTRS_TEXTSTYLE#u}@{tab}
@{" @{wbstart ...} " link ATTRS_LINKS#wbstart}@{tab}
@{cleartabs}
@{m_endsec}
@endnode
@node ATTRS_JUSTIFICATION "HyperGuide/Attributes/Justification"

@{m_sec "Justification"}
@{definition}
@{defterm}@{m_attr jcenter}
@{defdata}turns center justification on.

@{defterm}@{m_attr jleft}
@{defdata}turns left justification on.

@{defterm}@{m_attr jright}
@{defdata}turns right justification on.
@{m_endsec}

@{m_sec "Example"}

@{m_hg_example}
\@{line}\@{jright}This text is right aligned
\@{line}\@{jcenter}This text is centered
\@{line}\@{jleft}This text is left aligned
@{m_hg_exampleend}

@{line}@{jright}This text is right aligned
@{line}@{jcenter}This text is centered
@{line}@{jleft}This text is left aligned
@{m_endsec}
@endnode
@node ATTRS_LINKS "HyperGuide/Attributes/Links"

@{m_sec "Links"}
@{definition}
@{defterm}@{label link}\@{"text" link <node name>}
@{defterm}\@{link text path}
@{defdata}defines a link with <text> as the visible part <path> the complete path
to a file to open, if this link is executed.
@{m_hgnew "V40.12"} : You can specify a label to link to within a node. This
is done the same way as in HTML. Just add a @{m_sample "#labelname"} to the node
name.

@{defterm}@{m_attr label " string"}
@{defdata}defines a label, which can be used to link to within a node

@{defterm}@{label rx}\@{"text" rx <rxcommand>}
@{defterm}\@{rx text script}
@{defdata}defines a button, which runs a ARexx-script, if its pressed.

@{defterm}@{label rxs}\@{"text" rxs <rxcommand>}
@{defterm}\@{rxs text string}"
@{defdata}defines a button, which executes a ARexx-string if its pressed.

@{defterm}@{label system}\@{"text" system <command>}
@{defterm}\@{system text command}
@{defdata}defines a button, which runs a normal program, if its pressed.

@{defterm}@{label quit}\@{"text" quit}
@{defterm}\@{quit text}
@{defdata}defines a button, which cause the program to quit, if its pressed.

@{defterm}@{label runcommand}\@{"text" runcommand <command>}
@{defterm}\@{runcommand text command}
@{defdata}defines a button, which runs a normal program using the RunCommand() system
call, if its pressed. This makes it possible to send a signal during deletion
of the object. Thus any this way started program could be terminated when the
object is disposed and the program supports Ctrl-C signal.@{line}
@{m_bold Note:} Currently there is a problem with the C:Execute program, which
doesn't work the RunCommand() right now.

@{defterm}@{label wbstart}\@{"text" wbstart <command>}
@{defterm}\@{wbstart text command}
@{defdata}defines a button, which starts a program using the wbstart.library, if its
pressed. This makes it possible to run a program totally independent from the
@{hyperguide} object. See also @{" WBStart Author " link HTDS.hguide/ThirdParty}.
@{enddefinition}
@{m_endsec}

@{m_sec "Example"}

@{m_hg_example}
\@{link " Text Style " , ATTRS_TEXTSTYLE} , \@{rx " Show MsgPorts " , /examples/ports.rexx} ,
\@{system " Start Clock " , Sys:Utilities/Clock} , \@{rxs " DisplayBeep " , "ADDRESS MULTIVIEW.1.1 BEEP"} ,
\@{" Label Definition " link #label}
@{m_hg_exampleend}

@{link " Text Style " , ATTRS_TEXTSTYLE} , @{rx " Show MsgPorts " , /examples/ports.rexx} ,
@{system " Start Clock " , Sys:Utilities/Clock} , @{rxs " DisplayBeep " , "ADDRESS MULTIVIEW.1.1 BEEP"} ,
@{" Label Definition " link #label}
@{m_endsec}
@endnode
@node ATTRS_LISTS "HyperGuide/Attributes/Lists"
@next ATTRS_MISC
@{m_sec "Lists"}
@{definition}
@{defterm}@{m_attr itemize " \"<bullet>\""}
@{defdata}starts a normal unordered list. The <bullet> phrase may be any
@{hyperguide} attribute which generates an visual object. Such as text or
embedded objects.

@{defterm}@{m_attr enditemize}
@{defdata}ends a normal unordered list

@{defterm}@{m_attr enumerate}
@{defdata}starts a enumeration list

@{defterm}@{m_attr endenumerate}
@{defdata}ends a enumeration list

@{defterm}@{m_attr item}
@{defdata}specifies an item for a \@{itemize} or \@{enumerate} list

@{defterm}@{m_attr definition}
@{defdata}starts a definition list

@{defterm}@{m_attr enddefinition}
@{defdata}ends a definition list

@{defterm}@{m_attr defterm}
@{defdata}specifies the term which should be defined. You can specify more than one
term for a definition

@{defterm}@{m_attr defdata}
@{defdata}specifies the definition of the previous term(s).
@{enddefinition}
@{m_sec "Intern used Macros"}
The following macros are used intern for highlight list headers and definition terms :
@{definition}
@{defterm}listhead
@{defdata}This macro specifies the which attributes should be inserted at the begin
of a list. This is the text directly followed by an \@{itemize},\@{enumerate} or
\@{definition} attribute.@{line}
Possibly good values are : @{m_sample "\@{b}"} or @{m_sample "\@{fg highlight}"}.

@{defterm}listheadend
@{defdata}This macro is the counterpart of the @{m_sample listhead} macro. So this
macro should reset the attributes which are set in the @{m_sample listhead} macro.@{line}
Possibly values are : @{m_sample "\@{ub}"} or @{m_sample "\@{fg text}"}.

@{defterm}deftermhead
@{defdata}This macro is for highlighting definition terms in a @{m_sample "\@{definition}"}
list.@{line}
Possibly good values are : \@{b} or \@{fg highlight}.

@{defterm}enddeftermhead
@{defdata}This macro is the counterpart for @{m_sample deftermhead} and should reset
any attribute the @{m_sample deftermhead} attribute changed.@{line}
Possibly values are : @{m_sample "\@{ub}"} or @{m_sample "\@{fg text}"}.
@{m_endsec}

@{m_sec "Example"}
@{enumerate}
@{item}@{" itemize list " link ATTRS_LISTS_EXAMPLES_ITEMIZE}
@{item}@{" enumerate list " link ATTRS_LISTS_EXAMPLES_ENUMERATE}
@{item}@{" deinition list " link ATTRS_LISTS_EXAMPLES_DEFINITION}
@{item}@{" itemize list with pic. bullet " link ATTRS_LISTS_EXAMPLES_ITEMIZE_PICBULLET}
@{endenumerate}
@endnode
@node ATTRS_LISTS_EXAMPLES_ITEMIZE "HyperGuide/Attributes/Lists/Itemize example"
@{m_sec "Itemize example"}
@{m_hg_example}
\@{itemize}
Itemize List

\@{item}This is the first item !\@{line}With a second line!
\@{item}This is the second item !
\@{item}This is the third item !
\@{enditemize}
@{m_hg_exampleend}

@{itemize}
Itemize List

@{item}This is the first item !@{line}With a second line!
@{item}This is the second item !
@{item}This is the third item !
@{enditemize}
@endnode
@node ATTRS_LISTS_EXAMPLES_ENUMERATE "HyperGuide/Attributes/Lists/Enumerate example"
@{m_sec "Enumerate example"}
@{m_hg_example}
\@{enumerate}
Enumeration List :

\@{item}One step left
\@{item}Two steps forward
\@{item}Three steps right
\@{endenumerate}
@{m_hg_exampleend}

@{enumerate}
Enumeration List :

@{item}One step left
@{item}Two steps forward
@{item}Three steps right
@{endenumerate}
@{m_endsec}
@endnode
@node ATTRS_LISTS_EXAMPLES_DEFINITION "HyperGuide/Attributes/Lists/Definition example"
@{m_sec "Definition example"}
@{m_hg_example}
\@{definition}
Definition List

\@{defterm}Term1\@{defterm}Term2
\@{defdata}Definition of Term1 and Term2
\@{defterm}Term3
\@{defdata}Definition of Term2
\@{enddefinition}
@{m_hg_exampleend}

@{definition}
Definition List

@{defterm}Term1@{defterm}Term2
@{defdata}Definition of Term1 and Term2
@{defterm}Term3
@{defdata}Definition of Term2
@{enddefinition}
@{m_endsec}
@endnode
@node ATTRS_LISTS_EXAMPLES_ITEMIZE_PICBULLET "HyperGuide/Attributes/Lists/Itemize pic. bullet example"
@{m_sec "Itemize pic. bullet example"}
@{m_hg_example}
\@{itemize "\@{object /pics/ipunct.png}"}
Itemize List

\@{item}This is the first item
\@{item}This is the second item
\@{item}This is the third item
\@{enditemize}
@{m_hg_exampleend}

@{itemize "@{object /pics/ipunct.png}"}
Itemize List

@{item}This is the first item
@{item}This is the second item
@{item}This is the third item
@{enditemize}
@endnode
@node ATTRS_MISC "HyperGuide/Attributes/Misc"
@prev ATTRS_LISTS
@{m_sec "Misc"}
@{definition}
@{defterm}@{m_attr amigaguide}
@{defterm}@{m_attr hyperguide}
@{defdata}displays the word HyperGuide in bold

@{defterm}@{m_attr object "<file>"}
@{defdata}embed the file <file> by using NewDTObjectA() (DTM_DRAW).
@{m_hgnew V40}

@{defterm}@{m_attr separator}
@{defdata}insert a separator line.
@{m_hgnew V40}
@{enddefinition}
@{m_endsec}

@{m_sec "Example"}

@{m_hg_example}
\@{amigaguide} ,\@{hyperguide}\@{separator}\@{object /pics/Attention.png}
@{m_hg_exampleend}

@{amigaguide} ,@{hyperguide}@{separator}@{object /pics/Attention.png}
@{m_endsec}
@endnode
@node ATTRS_PARAGRAPH "HyperGuide/Attributes/Paragraph"

@{m_sec "Paragraph"}
@{definition}
@{defterm}@{m_attr body}
@{defdata}Indicate that the following text is the body of the
document. Word Wrap will be turned back on if it is the default.

@{defterm}@{m_attr code}
@{defdata}Indicate that the following text is not to be word-wrapped.

@{defterm}@{m_attr lindent "<chars>"}
@{defdata}Set the number of spaces to indent the body of a paragraph.

@{defterm}@{m_attr line}
@{defdata}Force a line feed without starting a new paragraph.

@{defterm}@{m_attr par}
@{defdata}Used to indicate the end of a paragraph. This is the same as two
sequential LF's in the source file.

@{defterm}@{m_attr pard}
@{defdata}Restore the default settings for a paragraph. Text pen to 1,
background to 0, normal style font, default font, and no indentation.

@{defterm}@{m_attr pari chars}
@{defdata}Set the number of spaces to indent the first line of
a paragraph relative to the normal paragraph indentation. The
value may be a negative number.

@{defterm}@{m_attr parset}
@{defdata}Set the current horizontal pixel position as the new bodyindent margin.
Now you can indent according to a \@{object ...}
@{m_hgnew V40}
@{enddefinition}
@{m_endsec}

@{m_sec "Example"}
@{m_hg_example}
\@{pari -5}\@{lindent 20}First line of paragraph five chars left\@{line}
paragraph body at twenty chars.\@{par}
@{m_hg_exampleend}

@{pari -5}@{lindent 20}First line of paragraph five chars left@{line}
paragraph body at twenty chars.@{par}
@{m_endsec}
@endnode
@node ATTRS_TEXTCOLOR "HyperGuide/Attributes/Text Color"

@{m_sec "Text Color"}
@{definition}
@{defterm}@{m_attr apen "<pennum>"}
@{defdata}set foreground pen to <pennum>.

@{defterm}@{m_attr bpen "<pennum>"}
@{defdata}set background pen to <pennum>.

@{defterm}@{m_attr bg "<colortext>"}
@{defdata}Used to change the background text color. Color
can be :
@{itemize}
@{item}Text
@{item}Shine
@{item}Shadow
@{item}Fill
@{item}FillText
@{item}Background
@{item}Highlight
@{enditemize}
@{defterm}@{m_attr fg "<colortext>"}
@{defdata}Used to change the foreground text color. The
same colors can be used as in the @{m_sample "\@{bg <colortext>}"} command.

@{defterm}@{m_attr bgrgb "<colorexpr>"}
@{defdata}Defines a new background color. @{m_high "<colorexpr>"} can be a
predefined color name like @{m_sample "white"} or a rgb value string :
@{m_sample "#RRGGBB"} with hexadecimal digits. See also @{"Color expressions" link hypertext.hguide/ColorExpressions}.

@{defterm}@{m_attr fgrgb "<colorexpr>"}
@{defdata}Defines a new forground color.
See also @{"Color expressions" link hypertext.hguide/ColorExpressions}.
@{enddefinition}
@{m_endsec}

@{m_sec "Example"}

@{m_hg_example}
\@{apen 2}TextColor set to pen 2\@{bpen 1} and background color to pen 1
\@{bg fill}Now background color to fill\@{fg shine} and text to shine
\@{fgrgb red}Red colored text \@{fg text}\@{bgrgb yellow}Yellow backgrounded text\@{bg back}
@{m_hg_exampleend}

@{apen 2}TextColor set to pen 2@{bpen 1} and background color to pen 1
@{bg fill}Now background color to fill@{fg shine} and text to shine
@{fgrgb red}Red colored text @{fg text}@{bgrgb yellow}Yellow backgrounded text@{bg back}
@{m_endsec}
@endnode
@node ATTRS_TEXTSTYLE "HyperGuide/Attributes/Text Style"

@{m_sec "Text Style"}
@{definition}
@{defterm}@{m_attr b}
@{defdata}turn on bold.

@{defterm}@{m_attr i}
@{defdata}turn italic on.

@{defterm}@{m_attr plain}
@{defdata}used to turn off all @{m_sample "\@{b}"}, @{m_sample "\@{i}"},
and @{m_sample "\@{u}"} commands.

@{defterm}@{m_attr style "[u]u[,[u]i][,[u]b][,n]"}
@{defdata}set font style, if the first character is a 'u' it undefine's
the following style. Styles are :
@{definition}
@{defterm}`u'
@{defdata}underlined
@{defterm}`i'
@{defdata}italic
@{defterm}`b'
@{defdata}bold
@{defterm}`n'
@{defdata}reset to normal style
@{enddefinition}
@{m_hgnew "V40"}

@{defterm}@{m_attr u}
@{defdata}turn underline on.

@{defterm}@{m_attr ub}
@{defdata}turn bold off.

@{defterm}@{m_attr ui}
@{defdata}turn italic off.

@{defterm}@{m_attr uu}
@{defdata}turn underline off.
@{enddefinition}
@{m_endsec}

@{m_sec "Example"}

@{m_hg_example}
\@{code}
\@{b}Bold
\@{i}Bold-Italic
\@{u}Bold-Italic-Underlined
\@{plain}\@{i}Italic
\@{u}Italic-Underlinded
\@{ui}Underlined
\@{plain}\@{style u,b}Underlined-Bold
\@{plain}\@{body}
@{m_hg_exampleend}

@{code}
@{b}Bold
@{i}Bold-Italic
@{u}Bold-Italic-Underlined
@{plain}@{i}Italic
@{u}Italic-Underlinded
@{ui}Underlined
@{plain}@{style u,b}Underlined-Bold
@{plain}@{body}
@{m_endsec}
@endnode
@node ATTRS_TEXTFONT "HyperGuide/Attributes/Text Font"

@{m_sec "Text Font"}
@{definition}
@{defterm}@{m_attr font "<fontname>[,<size>]"}
@{defdata}Used to set a TextFont, with name <fontname> and size <size>.
If size isn't specified 8 is used.
@{m_hgnew "V40"}

@{defterm}@{m_attr stdfont}
@{defdata}Reset to standard font.
@{m_hgnew "V40"}

@{defterm}@{m_attr deffont}
@{defdata}Reset to default font. This is now a macro.
@{m_hgnew "V40"}
@{enddefinition}
@{m_endsec}

@{m_sec "Example"}

@{m_hg_example}
\@{line}\@{font courier,18}This is Courier 18\@{deffont}, the default \@{font diamond,15}and this Diamond 15
\@{line}\@{font diamond,15}again Diamond 15\@{deffont}, the default \@{font courier,18} and Courier 18
@{m_hg_exampleend}

@{line}@{font courier,18}This is Courier 18@{deffont}, the default @{font diamond,15}and this Diamond 15
@{line}@{font diamond,15}again Diamond 15@{deffont}, the default @{font courier,18} and Courier 18
@{m_endsec}
@endnode
@node ATTRS_TABULATOR "HyperGuide/Attributes/Tabulator"

@{m_sec "Tabulator"}
@{definition}
@{defterm}@{m_attr cleartabs}
@{defdata}Restore the default tab stops.

@{defterm}@{m_attr tab}
@{defdata}the same as character 9 in the source file.

@{defterm}@{m_attr settabs "<n> ... <n>"}
@{defdata}This is used to establish tab stops.
@{enddefinition}
@{m_endsec}

@{m_sec "Example"}

@{m_hg_example}
\@{settabs 20 40 60}
\@{code}
\@{b}Name\@{tab}Street\@{tab}City\@{tab}Country\@{ub}
\@{separator}
Ruppert,Stefan\@{tab}Windthorststr. 5\@{tab}Flörsheim\@{tab}Germany
\@{separator}
\@{body}
\@{cleartabs}
@{m_hg_exampleend}

@{settabs 20 40 60}
@{code}
@{b}Name@{tab}Street@{tab}City@{tab}Country@{ub}
@{separator}
Ruppert,Stefan@{tab}Windthorststr. 5@{tab}Flörsheim@{tab}Germany
@{separator}
@{body}
@{cleartabs}

@{m_endsec}
@endnode

@node StdMacros "HyperGuide/Standard macros"
@{m_sec "Why standard macros ?"}
These macros are defined to let the user customize the appearance of any
@{hyperguide}, which uses the standard macros. For example one user has a
screen size of 640x400 and another 800x600, so these two user needs different
font sizes for the different sections of a @{hyperguide} document. The
first one sets the title font size two 15 pixel and the second user perhaps to
24 pixel.
@{m_endsec}

@{m_sec "Current standard macros :"}

@{m_sub Fonts}
@{definition}
@{defterm}\@{titlefont}
@{defdata}Normally used to display the document title. This should be the biggest of the
standard font macros.
@{line}Default: @{m_sample "times 24"}

@{defterm}\@{subtitlefont}
@{defdata}Normally used to display the document sub title or the title of a internal node.
This should be smaller than the @{m_sample "\@{titlefont}"}.
@{line}Default: @{m_sample "times 15"}

@{defterm}\@{chapterfont}
@{defdata}Normally used to display the chapter title.
@{line}Default: @{m_sample "times 15"}

@{defterm}\@{sectfont}
@{defdata}Normally used to display the title of a section within a document.
This should be smaller than the @{m_sample "\@{subtitlefont}"}.
@{line}Default: @{m_sample "times 13"}

@{defterm}\@{subsectfont}
@{defdata}Normally used to display the title of a sub section within a document.
This should be smaller than the @{m_sample "\@{sectfont}"}.
@{line}Default: @{m_sample "times 11"}

@{defterm}\@{fixedfont}
@{defdata}macro for fixed size fonts
@{line}Default: @{m_sample "courier 11"}

@{defterm}\@{bigfont}
@{defdata}macro for big fonts :)
@{line}Default: @{m_sample "helvetica 24"}

@{defterm}\@{smallfont}
@{defdata}macro for small fonts :)
@{line}Default: @{m_sample "helvetica 9"}
@{enddefinition}

@{m_sub Misc}
@{definition}
@{defterm}\@{point}
@{defdata}Used to define the begin of an item within an list or enumeration
@{line}Default: @{m_sample ·}
@{enddefinition}
@{m_endsec}

@{m_sub Internet}@{line}
The following internet macros are placed in the @{m_file "internet.hgm"} file :

@{definition}
@{defterm}\@{mailto <text> <email-address> <subject>}"
@{defdata}Used to define a button to execute a mailer program for the given email
address and subject.
@{line}Default: @{m_sample "\@{\\\"$1\\\" rx \\\"mail.rexx $2 $3\\\"}"}

@{defterm}\@{http <text> <url>}
@{defdata}Used to define a button to execute a HTML browser program for the given URL.
This is used to open a html page in the WWW. In future this can be a simple
\@{object} attribute if the html.datatype is available.
@{line}Default: @{m_sample "\@{\\\"$1\\\" rx \\\"http.rexx $2\\\"}"}

@{defterm}\@{aminet <text> <aminetpath>}
@{defdata}Used to define a button to execute a aminet access program for the given
aminet file. The file should be consist of the aminet directory and file
name. For example : @{b}util/dtype/HTDS.lha@{ub}
@{line}Default: @{m_sample "\@{\\\"$1\\\" rx \\\"aminet.rexx $2\\\"}"}

@{defterm}\@{ftp <text> <ftp-address>}
@{defdata}Used to define a button to execute a ftp access program for the given ftp
address.
@{line}Default: @{m_sample "\@{\\\"$1\\\" rx \\\"ftp.rexx $2\\\"}"}
@{enddefinition}
For all these macros there exists a special version, which displays the
appropriate address as the text link. Just add a @{m_high "_addr"} to the
macro name and omit the text field.
@{m_endsec}


@{m_sec "Default Macro File"}
For each @{HyperGuide} object, the hyperguide.datatype tries to load the
@{m_file Default.hgm} macro file. This have to be in the directory configured
by the @{HyperGuide} @{"prefs" link Configuration} file. If you haven't set a
macro directory, it have to be in the @{m_file Help:HyperGuide} directory.@{line}
@{m_endsec}

@{m_sec "See Also"}
@{" Macros " link Cmds_Macro}, @{" Configuration " link Configuration},
@{" Text Font " link ATTRS_TEXTFONT}
@{m_endsec}
@endnode

@node Compatibility "HyperGuide/Compatibility"

@{m_sec Compatibility}
The following things differ to the current AmigaGuide datatype. So please
read it :

@{m_sub "Attributes"}@{line}
The attribute @{" @{amigaguide} " link ATTRS_MISC#amigaguide} display's @{amigaguide}.

@{m_sub "Links"}@{line}
Currently a link to a specific line in a document is not supported.

@{m_sub "Commands"}
@{itemize}
@{item}The command @{m_sample \@height} and @{m_sample \@width} aren't implemented.
What use have these commands ? I don't known.
@{item}The @{m_sample \@onopen} and @{m_sample \@onclose} commands aren't implemented yet.
This will be done later.
@{item}The command @{m_sample \@dnode} is not supported and it isn't a keyword.
@{item}The @{m_sample \@keywords} command isn't implemented yet. This will be done later.
@{enditemize}

@{m_sub "ARexx Commands"}@{line}
The @{m_sample GETNODECOUNT} and @{m_sample PRINT} commands aren't implemented yet.
See @{" ARexx Interface " link hypertext.hguide/ARexxIFace} of the HyperText DataType.
@{m_endsec}
@endnode
@node NewFeatures "HyperGuide/NewFeatures"

@{m_sec "New Features"}
@{m_sub "Attributes"}@{line}
@{itemize}
@{item}@{"background" link Cmds_Background} pics and colors
@{item}@{" @{fgrgb ... } and @{bgrgb ...} " link ATTRS_TEXTCOLOR#bgrgb} for defining a specific color
@{item}@{" @{label ...} " link ATTRS_LINKS#label} to go to specific section within a node
@{item}Now real @{"lists" link ATTRS_LISTS} support
@{item}Multiple @{"Font" link ATTRS_TEXTFONT} support
@{item}Embedding of @{"DataTypes Objects" link ATTRS_MISC}
@{item}@{"Separator" link ATTRS_MISC} line
@{item}New @{"link" link ATTRS_LINKS#link} style: \@{link "text",link}
@{item}New @{"command launching" link ATTRS_LINKS} commands : \@{wbstart ...} and \@{runcommand ...}
@{item}New @{"text style" link ATTRS_TEXTSTYLE} command
@{item}New @{"@{parset}" link ATTRS_PARAGRAPH#parset} command
@{enditemize}

@{m_sub "Commands"}@{line}
@{m_sample \@include} command to include @{"macro" link Cmds_Macro} definitions

@{m_sub "ARexx Commands"}@{line}
The @{hyperguide} DataType has no own ARexx port. The HyperText DataType has
one. See @{" ARexx Interface " link hypertext.hguide/ARexxIFace} of that DataType.

@{m_sub "Buttons"}@{line}
The @{hyperguide} DataType don't handle the buttons. The HyperText DataType does
this. See @{" Buttons " link hypertext.hguide/UserIFace_Navigator} of that DataType.
@{m_endsec}
@endnode